home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIFileProtocolHandler.idl < prev    next >
Text File  |  2006-05-08  |  3KB  |  81 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2001
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Darin Fisher <darin@netscape.com> (original author)
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsIProtocolHandler.idl"
  40.  
  41. interface nsIFile;
  42.  
  43. [scriptable, uuid(255602ea-c31f-4d29-8f35-905ead3f76f4)]
  44. interface nsIFileProtocolHandler : nsIProtocolHandler
  45. {
  46.     /**
  47.      * This method constructs a new file URI 
  48.      *
  49.      * @param aFile nsIFile
  50.      * @return reference to a new nsIURI object
  51.      */
  52.     nsIURI newFileURI(in nsIFile aFile);
  53.  
  54.     /**
  55.      * Converts the nsIFile to the corresponding URL string.  NOTE: under
  56.      * some platforms this is a lossy conversion (e.g., Mac Carbon build).
  57.      * If the nsIFile is a local file, then the result will be a file://
  58.      * URL string.
  59.      *
  60.      * The resulting string may contain URL-escaped characters.
  61.      */
  62.     AUTF8String getURLSpecFromFile(in nsIFile file);
  63.  
  64.     /**
  65.      * Converts the URL string into the corresponding nsIFile if possible.
  66.      * A local file will be created if the URL string begins with file://.
  67.      */
  68.     nsIFile getFileFromURLSpec(in AUTF8String url);
  69.  
  70.     /**
  71.      * Takes a local file and tries to interpret it as an internet shortcut
  72.      * (e.g. .url files on windows).
  73.      * @param file The local file to read
  74.      * @return The URI the file refers to
  75.      *
  76.      * @throw NS_ERROR_NOT_AVAILABLE if the OS does not support such files.
  77.      * @throw NS_ERROR_NOT_AVAILABLE if this file is not an internet shortcut.
  78.      */
  79.     nsIURI readURLFile(in nsIFile file);
  80. };
  81.